Environments
To start using an execution environment, you need to:
- Add the execution environment in the Controller
- Install an agent
- Launch your agent
- Configure your agent
Add an Execution Environment
Before you install and configure an agent to run your tests, you must add an execution environment. This process generates a unique access key (.ini
file) that you’ll need to complete your agent setup.
To set up an execution environment, follow these steps:
-
Log in to Eggplant DAI.
-
Go to Controller > Environments. The Environments page opens showing a list of existing execution environments and their status.
-
Click Add New +.
-
In the Name box, enter a unique name for the execution environment with no spaces.
ノートThe agent can run on the same machine as the Eggplant DAI server, or any local or hosted machine that can connect to the Eggplant DAI server via the network.
-
(Optional) Enter the full path to access the .CSV files for using with code snippets in the suite. For example, for a .CSV file located on your desktop, enter
C:\Users\Eggy\Desktop\
. -
Click Save.
-
When the Agent access key dialog box appears, click Download and store the
.ini
file in a secure location. The details of the new execution environment then appears on the Environments page. -
Continue to the next section.
Install an Agent
The agent is available as a Windows .exe file, a Mac app, and Linux binaries for CentOS/Red Hat and Ubuntu/Debian. The following OS versions are supported:
- Windows: 64-bit Windows 7 and 10, Windows Server 2012, 2016, 2019
- macOS: macOS 10.12, 10.13, 10.14, 10.15 (Note: Big Sur is not currently supported)
- Linux: RedHat 7, CentOS 7, Ubuntu 16 (64-bit)
- On the Environments page, click Agent Tools.
- From the Agent Installer list, select the platform that you use.
- Select Download to save the installation file to your Downloads folder.
- Open your Downloads folder and use the following platform-specific instructions.
For Windows
Double-click eggplantAIagent.exe
and follow the prompts to complete the installation.
For macOS
- Double-click
eggplantAIagent.dmg
. - Drag
eggplantAIagent.app
into your Applications folder.
For Linux
The steps for extracting and running the agent are the same across different Linux platforms, although the name of the archive file may differ.
-
Either manually extract
eggplantAIagent-CentOS-RedHat.tar.gz
oreggplantAIagent-Ubuntu-Debian.tar.gz
to your preferred directory, or use the following script.cd $HOME
mkdir eggplant
tar -xzf eggplantAIagent-CentOS-4.2.0.tar.gz -C "$HOME/eggplant" -
(Optional) To run
eggplantAIagent
directly from the command line, addexport PATH="$PATH:$HOME/eggplant"
to your.bashrc
or.zshrc
file, or use the following commands:cd $HOME/eggplant
./eggplantAIagent
Launch Your Agent
You can launch the Eggplant DAI Agent from the Start menu on Windows or from the Applications folder on a Mac. You can also run the agent from the command line without a UI. In all cases, the Eggplant DAI Agent is launched ready for you to complete your setup.
For Windows
Open eggplantAiagent from the Start menu.
For macOS
Launch the eggplantAiagent from the Applications folder.
For Linux
Launch your Eggplant DAI Agent from the terminal.
-
Open a command prompt.
-
Find the directory where you extracted the
.tar.gz
file, e.g.:cd $HOME/eggplant
-
Enter the following command to run the agent:
./eggplantAIagent
Configure Your Agent
To log in and start using your agent, you must:
- Add your agent access key
- Enter your connection details and preferences.
Add Your Agent Access Key
- On the eggplant DAI agent dialog box, select Add New and browse to the access key (
.ini
file) that you downloaded in Add an Execution Environment or Regenerate Access Key. - Click Open. The Execution Environment box shows the name and URL of the execution environment that you created and the details are automatically added to an environment settings file on your computer.
- Click Login to authenticate with your Eggplant DAI environment. A new Eggplant DAI Agent dialog box appears as soon as your access key is verified.
- Delete the access key from your computer.